<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
  <head>
    <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
    <title>DB_ENV-&gt;set_ext_file_threshold()</title>
    <link rel="stylesheet" href="apiReference.css" type="text/css" />
    <meta name="generator" content="DocBook XSL Stylesheets V1.73.2" />
    <link rel="start" href="index.html" title="Berkeley DB C API Reference" />
    <link rel="up" href="blob.html" title="Chapter 13.  External Files" />
    <link rel="prev" href="envset_blob_dir.html" title="DB_ENV-&gt;set_ext_file_dir()" />
    <link rel="next" href="utilities.html" title="Appendix A.  Berkeley DB Command Line Utilities" />
  </head>
  <body>
    <div xmlns="" class="navheader">
      <div class="libver">
        <p>Library Version 12.1.6.2</p>
      </div>
      <table width="100%" summary="Navigation header">
        <tr>
          <th colspan="3" align="center">DB_ENV-&gt;set_ext_file_threshold()</th>
        </tr>
        <tr>
          <td width="20%" align="left"><a accesskey="p" href="envset_blob_dir.html">Prev</a> </td>
          <th width="60%" align="center">Chapter 13. 
                External Files
        </th>
          <td width="20%" align="right"> <a accesskey="n" href="utilities.html">Next</a></td>
        </tr>
      </table>
      <hr />
    </div>
    <div class="sect1" lang="en" xml:lang="en">
      <div class="titlepage">
        <div>
          <div>
            <h2 class="title" style="clear: both"><a id="envset_blob_threshold"></a>DB_ENV-&gt;set_ext_file_threshold()</h2>
          </div>
        </div>
      </div>
      <pre class="programlisting">#include &lt;db.h&gt;

int
DB_ENV-&gt;set_ext_file_threshold(DB_ENV *dbenv, u_int32_t bytes, 
                           u_int32_t flags);  </pre>
      <p>
        The <code class="methodname">DB_ENV-&gt;set_ext_file_threshold()</code> method sets
        a default size for the environment which is used to determine when
        a data item will be stored as an external file. Data items sized less
        than this threshold are stored as normal data within the database. Data
        items larger than this size are stored on-disk in a subdirectory
        set aside for the purpose.
    </p>
      <p>
         If this threshold value is set to <code class="literal">0</code>, then external
         file support is turned off by default for databases created in the
         environment. If this method is never called, then the default external
         file threshold is <code class="literal">0</code>.
     </p>
      <p>
         This method only sets the default external file threshold for the
         environment. The external file threshold can be set for individual
         databases created within the environment using
         <a class="xref" href="set_blob_threshold.html" title="DB-&gt;set_ext_file_threshold()">DB-&gt;set_ext_file_threshold()</a>.
     </p>
      <p>
         This method configures operations performed using the specified
         <a class="link" href="env.html" title="Chapter 5.  The DB_ENV Handle">DB_ENV</a> handle, not all operations
         performed on the underlying database environment.
     </p>
      <p>
         You may call this method at any time after the DB_ENV handle
         has been created.
     </p>
      <p>
         Unless otherwise specified, the
         <code class="methodname">DB_ENV-&gt;set_ext_file_threshold()</code> <span>
            <span>
                  method returns a non-zero error value on failure and 0 on success.
            </span>
            
        </span>
     </p>
      <div class="sect2" lang="en" xml:lang="en">
        <div class="titlepage">
          <div>
            <div>
              <h3 class="title"><a id="idm140711171658032"></a>Parameters</h3>
            </div>
          </div>
        </div>
        <div class="sect3" lang="en" xml:lang="en">
          <div class="titlepage">
            <div>
              <div>
                <h4 class="title"><a id="idm140711171659280"></a>bytes</h4>
              </div>
            </div>
          </div>
          <p>
                 The <span class="bold"><strong>bytes</strong></span> parameter
                 identifies the threshold size, in bytes, beyond which a
                 data item is stored as an external file.
             </p>
        </div>
        <div class="sect3" lang="en" xml:lang="en">
          <div class="titlepage">
            <div>
              <div>
                <h4 class="title"><a id="idm140711171676192"></a>flags</h4>
              </div>
            </div>
          </div>
          <p>
                  The <span class="bold"><strong>flags</strong></span> parameter must be
                  set to 0.
             </p>
        </div>
      </div>
      <div class="sect2" lang="en" xml:lang="en">
        <div class="titlepage">
          <div>
            <div>
              <h3 class="title"><a id="idm140711171661232"></a>Errors</h3>
            </div>
          </div>
        </div>
        <p>
             The <code class="methodname">DB_ENV-&gt;set_ext_file_threshold()</code> <span>
            <span>
                 method may fail and return one of the following non-zero errors:
            </span>
            
        </span>
        </p>
        <div class="sect3" lang="en" xml:lang="en">
          <div class="titlepage">
            <div>
              <div>
                <h4 class="title"><a id="idm140711171677712"></a>EINVAL</h4>
              </div>
            </div>
          </div>
          <p>
                If an invalid flag or parameter was specified.
            </p>
        </div>
      </div>
      <div class="sect2" lang="en" xml:lang="en">
        <div class="titlepage">
          <div>
            <div>
              <h3 class="title"><a id="idm140711171646288"></a>Class</h3>
            </div>
          </div>
        </div>
        <p>
            <a class="link" href="env.html" title="Chapter 5.  The DB_ENV Handle">DB_ENV</a>  
        </p>
      </div>
      <div class="sect2" lang="en" xml:lang="en">
        <div class="titlepage">
          <div>
            <div>
              <h3 class="title"><a id="idm140711171658192"></a>See Also</h3>
            </div>
          </div>
        </div>
        <p>
             <a class="xref" href="blob.html#bloblist" title="External Files and Related Methods">External Files and Related Methods</a> 
        </p>
      </div>
    </div>
    <div class="navfooter">
      <hr />
      <table width="100%" summary="Navigation footer">
        <tr>
          <td width="40%" align="left"><a accesskey="p" href="envset_blob_dir.html">Prev</a> </td>
          <td width="20%" align="center">
            <a accesskey="u" href="blob.html">Up</a>
          </td>
          <td width="40%" align="right"> <a accesskey="n" href="utilities.html">Next</a></td>
        </tr>
        <tr>
          <td width="40%" align="left" valign="top">DB_ENV-&gt;set_ext_file_dir() </td>
          <td width="20%" align="center">
            <a accesskey="h" href="index.html">Home</a>
          </td>
          <td width="40%" align="right" valign="top"> Appendix A. 
                Berkeley DB Command Line Utilities
        </td>
        </tr>
      </table>
    </div>
  </body>
</html>
